Custom Character Mod

> Installing the mod and characters
	1.	Download and install MTG. Instructions on how to do this are included on 
		the modworkshop page. 
	
	2.	Download and install the Custom Characters mod. Run the game once to create the 
		CustomCharacterData folder in your Enter the Gungeon directory.
	
	3.	To install custom characters, download a custom character ZIP and extract 
		the outermost folder. Move that folder to the CustomCharacterData folder.
		
	4.	To use a custom character, open the game, and open the console with ‘F2’.
		a.	There should be a list in the console of all the characters that were 
			successfully created. 
		b.	To play as one of them, type the command `character <characterName>` 
			where <characterName> is the name of the character in the list.
		
> Creating characters
	Before you get overwhelmed at the wealth of information here, 
	be aware that there are several example characters on the workshop 
	page that you can reference!
	
	1.	Create a new folder in CustomCharacterData. The name of this folder is irrelevant, 
		but it’s what people are going to see in their character folder, 
		so it’s a good idea to make it something that people will associate 
		with your character. I usually just make it some one-word descriptor.
		
		You can add the following files/folders to your character folder (more details 
		on these items below):
		
			o	characterdata.txt - REQUIRED
			
			o	playersheet.png OR 'sprites' folder
			o 	bosscard.png (427x240)
			o	facecard.png (34x34)
			o	icon.png (9x9)
			
			o	'punchout' folder
				>	'punchout/sprites' folder 
				>	facecard1, facecard2, and facecard3.png
		
	2.	Create the character data file
		
		o	Make a .txt file in your character folder called ‘characterdata.txt’. 
			This file will give the mod important information about how to load your 
			character, as well as determine your character’s attributes. There are only 
			two required components for this file:
		
				i. Base
					>	You can choose from the following bases:
						o	Bullet
						o	Convict
						o	Gunslinger
						o	Hunter
						o	Marine / Soldier
						o	Paradox / Eevee
						o	Pilot / Rogue
						o	Robot
					>	This will determine the internal character identity of your character. 
						You’ll go to the base’s past, the sprites that the game loads will be 
						for this character, and your character will have the same attributes as this base. 
						
				ii. Name short
					>	This will be the internal name the game uses for your character. 
						People will type this to load the character.
			
		o	The other attributes are optional:
			i.	Name
				>	Not yet implemented – If I ever make it so you can choose custom characters in the breach,
					this will be the name that appears above your head during character select
					
			ii.	Nickname
				>	Not yet implemented – This will be the name NPC’s call you when you talk to them.

			iii.	Armor
				>	Starting armor of your character. This is set to 6 by default if your base is the robot.
				
			iv.	Loadout
				>	This is a list of your character’s starting items. The list should be composed of MTG item ID’s 
					(chicken_flute, shades_revolver, etc.) and should be enclosed in html-style tags, 
					i.e <loadout> ... </loadout>. Each item should be on a new line.
				
				>	If one of the items is a gun, and you want it to have infinite ammo, just add “infinite” after 
					the ID. For example: “makarov infinite”
					
			v.	Stats
				>	As with loadouts, this should be enclosed with <stats> … </stat>
				>	This is a list of the base stats of your character. The following stats can be edited
					but not all of them need to be explicitly set (you can leave any of them out): 
					o	Accuracy: 1
					o	AdditionalBlanksPerFloor: 0
					o	AdditionalClipCapacityMultiplier: 1
					o	AdditionalGunCapacity: 0
					o	AdditionalItemCapacity: 0
					o	AdditionalShotBounces: 0
					o	AdditionalShotPiercing: 0
					o	AmmoCapacityMultiplier: 1
					o	ChargeAmountMultiplier: 1
					o	Coolness: 0
					o	Curse: 0
					o	Damage: 1
					o	DamageToBosses: 1
					o	DodgeRollDamage: 1
					o	DodgeRollDistanceMultiplier: 1
					o	DodgeRollSpeedMultiplier: 1
					o	EnemyProjectileSpeedMultiplier: 1
					o	ExtremeShadowBulletChance: 0
					o	GlobalPriceMultiplier: 1
					o	Health: 3
					o	KnockbackMultiplier: 1
					o	MoneyMultiplierFromEnemies: 1
					o	MovementSpeed: 7
					o	PlayerBulletScale: 1
					o	ProjectileSpeed: 1
					o	RangeMultiplier: 1
					o	RateOfFire: 1
					o	ReloadSpeed: 1
					o	ShadowBulletChance: 0
					o	TarnisherClipCapacityMultiplier: 1
					o	ThrownGunDamage: 1
						
	3.	Add sprites
		
		If you're planning on doing anything with sprites, you need to download the sprite dumps. 
		Links to these files can be found on the modworkshop page.
		
		a.	There are multiple sprites you can replace: 
		
			i.	Player animations
				>	There are two ways of replacing player animations:
				
					1.	Player sheet
						>	Retrieve your base character’s sprite sheet from the TK2D sprite dump, 
							alter it, and then rename the file to ‘playersheet.png’. Then drop the 
							file into the character folder. 
							
					2.	Sprite set
						>	Create a new folder called ‘sprites’ in the character folder. 
							Retrieve all of your base character’s player animation frames from the 
							TK2D sprite dump, alter the sprites, and then place them into the sprites 
							folder you created. The sprites should have the same name as they did in the dump.
							
			ii.	Boss card
				>	Create a new 427x240 image file called “bosscard.png”, edit it, and place it into 
					the character folder
				
			iii.	Mini-map icon
				>	Create a new 9x9 image file called “icon.png”, edit it, and place it into the character folder
				
			iv.	Face card
				>	Create a new 34x34 image file called “facecard.png”, edit it, and place it into the character folder

			vi.	Foyer face card
				>	Create a new folder called "foyercard" in the character folder

				> 	Retrieve your base character’s foyer card sprites from the TK2D sprite dump (they should be in a folder 
					called "Facecard_Collection" edit them, and then place them into the 'foyercard’ folder within your 
					character folder
				
			v.	Punchout animations
				>	Create a new folder called ‘punchout’ in the character folder. Within this folder, create another called ‘sprites’. 
				
				>	Retrieve your base character’s punchout sprites from the TK2D sprite dump (they should be in a folder 
					called ‘Boss_Liquid_Punch_Out_Collection’), edit them, and then place them into the ‘punchout/sprites’ 
					folder within your character folder
					
			vi.	Punchout face cards
				>	Create a new folder called ‘punchout’ in the character folder
				
				>	Create three new 34x34 image files called facecard1.png, facecard2.png, and facecard3.png, edit them, and place
					them into the ‘punchout’ folder within your character folder